<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
    <style>
        h1{
            text-align: center;
            font-size: 20px;
        }
        h2{
            text-align: center;
        }
        h3,h4{
            text-align: center;
        }
        [v-lock]{
            display: none;
        }
        #app{
            width:90%;
            margin: 0 auto;
            font-size: 14px;
        }
        table{
            width: 100%;
            border: 1px solid #eee;
            text-align: center;;
        }
        th,td{
            border: 1px solid #eee;
            line-height: 28px;
        }
        tbody tr:nth-child(odd){
            background: rgba(51, 133, 255,0.1);
        }
    </style>
</head>
<body>
<h1>欢迎来到召唤师峡谷----之绝世文档</h1>
<h2>接口 host 地址：http://localhost:7788/ </h2>
<h3>
    <a href="http://localhost:7788/login">登录页测试</a>&nbsp;
    <a href="http://localhost:7788/register">注册页测试</a>
</h3>
<h4>
    <b>接口说明：</b>
    <p>以 /api/web 开头的接口，是不需要登陆，就可以使用的 。</p>
    <p>以 /api/app 开头接口，需要登陆才能使用，未登陆 code 将为 1003 。</p>
    <p>以 /api/admin 开头接口，需要<b>管理员账户</b>登陆才能使用，未登陆 code 将为 1003 。</p>
    <p>接口正常返回code为 200</p>
</h4>
<div id="app" v-lock>
    <table border="1" cellspacing="0" cellpadding="0">
        <thead>
            <tr>
                <th>序号</th>
                <th>描述</th>
                <th>方式</th>
                <th>地址</th>
                <th>参数</th>
                <th>返回值</th>
                <th>字段描述</th>
            </tr>
        </thead>
        <tbody>
            <tr v-for="(item,index) in list" :key="index">
                <td>{{index+1}}</td>
                <td>{{item.desc}}</td>
                <td>{{item.method || "GET"}}</td>
                <td>{{item.url}}</td>
                <td>{{item.params}}</td>
                <td>{{item.back}}</td>
                <td>{{item.key || "无"}}</td>
           </tr>
        </tbody>
        
    </table>
</div>
</body>
<script src="/public/javascripts/vue.min.js"></script>
<script>
    let vm = new Vue({
        el:"#app",
        data(){
            return {
                list:Object.freeze([
                    {
                        desc:"注册",
                        method:"POST",
                        url:"/api/web/user/register",
                        params:"{ tel: 手机号码 ,password:密码 }",
                        back:"{code:200,data:xxxx}"
                    },
                    {
                        desc:"登录",
                        method:"POST",
                        url:"/api/web/user/login",
                        params:"{ tel: 手机号码 ,password:密码,name:用户名 }",
                        back:"{code:200,data:xxxx}"
                    },
                    {
                        desc:"退出登录",
                        method:"POST",
                        url:"/api/web/loginout",
                        params:"{ }",
                        back:"{code:200,data:xxxx}"
                    },
                    {
                        desc:"获取自己的用户信息",
                        method:"GET",
                        url:"/api/app/user",
                        params:"{ }",
                        back:"{code:200,data:xxxx}"
                    },
                    {
                        desc:"获取别人的用户信息",
                        method:"GET",
                        url:"/api/web/user/info",
                        params:"{id:用户id }",
                        back:"{code:200,data:xxxx}",
                        key:"id 为他人的用户id"
                    },
                    {
                        desc:"Tag 新建",
                        method:"POST",
                        url:"/api/app/tag/add",
                        params:"{ name:tag的名称}",
                        back:"{code:200,data:xxxx}",
                        key:""
                    },
                    {
                        desc:"Tag 删除",
                        method:"POST",
                        url:"/api/app/tag/remove",
                        params:"{ id:tag的id}",
                        back:"{code:200,data:xxxx}",
                        key:""
                    },
                    {
                        desc:"Tag 更新",
                        method:"POST",
                        url:"/api/app/tag/update",
                        params:"{ id:tag的id,name:tag的名称}",
                        back:"{code:200,data:xxxx}",
                        key:""
                    },
                    {
                        desc:"Tag 列表",
                        method:"GET",
                        url:"/api/app/tag/list",
                        params:"{ }",
                        back:"{code:200,data:[] }",
                        key:""
                    },
                    {
                        desc:"Note 新建",
                        method:"POST",
                        url:"/api/app/note/add",
                        params:"{title:笔记名称,content:笔记内容, tagId:tag 的id, state: 可以不传, password:访问密码，可以不传，在 state为3的时候有效 ,type:笔记的类型 可以不传}",
                        back:"{code:200,data:xx }",
                        key:"state: 1、 公开 ， 2、 只能自己看 ， 3、 密码访问  ； type: 1、markdown ， 2 、画图 "
                    },
                    {
                        desc:"Note 删除",
                        method:"POST",
                        url:"/api/app/note/remove",
                        params:"{id:笔记的id }",
                        back:"{code:200,data:xxx }",
                        key:" "
                    },
                    {
                        desc:"Note 更新",
                        method:"POST",
                        url:"/api/app/note/update",
                        params:"{id:笔记的id, 其余字段和新建一样，有就修改，没有就不修改 }",
                        back:"{code:200,data:xxx }",
                        key:""
                    },
                    {
                        desc:"Note 列表",
                        method:"GET",
                        url:"/api/app/note/list",
                        params:"{ pageSize: 每页多少条可选, pageNum:第几页可选 , tagName:查询可选, tagId:查询可选 ,  title: 查询可选, state: 查询可选 ，orderby:时间顺序 还是 title 排序 默认时间排序 }",
                        back:"{code:200,data:xxx }",
                        key:"orderby 可以为 title 、 updatedAt "
                    },
                    {
                        desc:"Note 详情",
                        method:"POST",
                        url:"/api/app/note/info",
                        params:"{id:笔记的id }",
                        back:"{code:200,data:xxx }",
                        key:""
                    },
                    {
                        desc:"Note 根据 tag分组统计数量",
                        method:"GET",
                        url:"/api/app/note/groupByTags",
                        params:"{}",
                        back:"{code:200,data:xxx }",
                        key:"导航头部的那个分组统计"
                    },
                    {
                        desc:"文件上传",
                        method:"POST",
                        url:"/api/web/file/upload",
                        params:"{  FormData }",
                        back:"{code:200,data:xxx }",
                        key:"传一个 new FormData(); 里面有 file 字段，详细查看 FileUp.vue 例子。图片最大允许10M"
                    },
                    {
                        desc:"bas64上传",
                        method:"POST",
                        url:"/api/web/file/imgdata",
                        params:"{  imgData:base64的字符串数据,ext: 文件的扩展名,例如 png , jpg }",
                        back:"{code:200,data:xxx }",
                        key:""
                    }
                ])
            }
        },
        methods:{

        }
    })
</script>
</html>